﻿#region File Description
///////////////////////////////////////////////////////////////////////////////
/// \file Transmission.cs
/// \brief This file stores the Transmission class
/// \author Bradley Mclain, Steven Duda
/// \date 16/5/2010
/// \remarks Copyright(c) 2010 LM01 Project Group (Animus Games - ViralFlux)
/// \remarks Some Rights Reserved.
/// Licenced under: Microsoft Reciprocal License (Ms-RL)
/// For More Information see: www.microsoft.com/opensource/licenses.mspx
///////////////////////////////////////////////////////////////////////////////
#endregion

using System;
namespace PropagationEngine
{
    /// <summary>
    /// \class Transmission
    /// \brief This class implements tracking and quantity of transmitted entities to a Node
    /// \author Bradley Mclain, Steven Duda
    /// \note A Transmission may have a Negative amount; this effectively removes/negates positive transmissions
    /// \date 16/5/2010
    /// </summary>
    public class Transmission
    {
        #region Properties

        public Entity ContainedEntity { get; private set; }
        public int Amount { get; set; }

        #endregion

        #region Methods

        /// <summary>
        /// \class Properties
        /// \brief Constructor for Transmission
        /// \param entity The entity that is transmitting
        /// \param amount The number of entities
        /// \author Bradley Mclain
        /// \date 16/5/2010
        /// </summary>
        public Transmission(Entity entity, int amount)
        {
            this.ContainedEntity = entity;
            this.Amount = amount;
        }

        #endregion

    }
}
